home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / BBS / GBULL102.ZIP / GLSBULL.DOC < prev    next >
Encoding:
Text File  |  1996-03-20  |  17.7 KB  |  423 lines

  1.                         Doc Release 08th March 1996
  2.  
  3.  
  4.  
  5.  
  6.           GreenLights Software Bulletin Generator
  7.  
  8.                     For
  9.  
  10.             RemoteAccess 2.00, 2.01, 2.02, 2.50
  11.  
  12.                   GLSBULL.EXE v1.02
  13.          FULL COLOUR ANSI,ASCII and RIP Bulletins
  14.  
  15.  
  16.   Copyright(c) 1996, Jeffrey R Dougall - GreenLights Software Development
  17.                   FidoNET 3:640/280
  18.                BBS +61 7 3201 6576 (9600-28800)
  19.  
  20.  
  21.             
  22.  
  23.  
  24.                     1
  25.  
  26.       1.1   License and disclaimer
  27.  
  28.       "GLSBULL"  refers to  the  executable  and  documentation  in  the
  29.       original distribution archive.  GLSBULL is copyrighted  material by
  30.       Jeffrey R. Dougall. It  may only be used  in agreement with  the
  31.       conditions set out in this license agreement.
  32.  
  33.       GLSBULL may  be freely distributed as long  as no files are removed
  34.       from the package and the files  are not modified in any way,  and
  35.       as  long  as no  money  or  any other  compensation  is asked  or
  36.       accepted for this  package without prior written  permission from
  37.       the author.
  38.  
  39.       Although  care has been  taken to write  and test a  program that
  40.       does what  this document states,  the program is provided  as is,
  41.       without warranty  or guarantee of  any kind, either  expressed or
  42.       implied, as to the quality or performance of this program, except
  43.       that it will occupy disk space.
  44.  
  45.       The author, Jeffrey R.  Dougall, will not be held  liable to you
  46.       or  anyone  for  (but  not  limited  to)  any  direct,  indirect,
  47.       incidental or consequential damages,  including any lost profits,
  48.  
  49.                       2
  50.  
  51.  
  52.  
  53.  
  54.  
  55.       lost savings  which may result from  the use or  inability to use
  56.       this program.
  57.  
  58.       Jeffrey R. Dougall   is in  no way  obligated to  provide future
  59.       versions of, or support for this software.
  60.  
  61.       Your  use  of  the  program constitutes  your  agreement  to this
  62.       license and  disclaimer and your  release of the author  from any
  63.       form of liability or litigation.
  64.  
  65.  
  66.  
  67.       1.2   Registration
  68.  
  69.       This release of GLSBULL may be used free of charge for  individual
  70.       hobby use in REGISTERED mode for a total period of 40 days after
  71.       which GLSBULL will de-activate REGISTERED mode and some features
  72.       will become in operate. GLSBULL may operate unpredictably if the
  73.       file(s) used to calculate the length of operation in FREE registered
  74.       mode are tampered with.
  75.       The following features will deactivate after 40 days, ALL message
  76.       posting abilities except for NEW CALLER WELCOME message. GLSBULL
  77.       will not read the GLSBULL.SKP file after 40 days, hence, only the
  78.       sysop will be excluded from the Bulletins. Apart from that GLSBULL
  79.       will continue creating bulletins for best callers etc but will
  80.       start displaying UNREGISTERED on the bulletins(Discretly).
  81.       Sound fair? Good, I'm a nice guy and understand some cannot afford
  82.       to pay for the ustilities they like to have for their BBS but
  83.       keep in mind that REGISTERING will re-activate ALL features.
  84.       
  85.       To register your copy of GLSBULL read the doc file GLSBULL.REG
  86.  
  87.  
  88.                      3
  89.  
  90.  
  91.           FILES used and created by GLSBULL.EXE
  92.           +++++++++++++++++++++++++++++++++++++
  93.  
  94.       GLSBULL.EXE The main executable file
  95.       GLSBULL.DAT Display information
  96.       GLSBULL.CFG Configuration file created by GLSBULL.EXE
  97.       GLSBULL.REC Created after running GLSBULL.EXE for the first time.
  98.           Used by GLSBULL so that dupe messages are not sent.
  99.       GLSPOST.EXE Used by GLSBULL to send messages.
  100.       GLSPOST.DAT Data file used by GLSPOST.EXE
  101.  
  102.     GLS??????.MSG files are explained below.
  103.     GLS??????.ASC bulletin you display to callers
  104.     GLS??????.RIP bulletins you display to RIPTERM(r) callers
  105.  
  106.       GLSBULL creates a file GLSBULL.REC when first run. this file
  107.       contains the names of the people a message was last sent to.
  108.       This is used by GLSBULL to ensure the same message is not sent
  109.       twice to a caller. The format is as follows
  110.  
  111.       GLSBULL.REC
  112.       -----------
  113.       Joan Doe    LINE 1 Top Uploader
  114.       Tom Doe     LINE 2 Top Caller
  115.       John Doe    LINE 3 Top Message writer
  116.           END
  117.  
  118.  
  119.       The program uses the following TEXT files as the base template for
  120.       posting messages to your callers ...
  121.  
  122.                   4
  123.  
  124.       GLSTHKF.MSG When a caller is NUMBER 1 in the top ten uploaders
  125.            GLSBULL will post this message to him/her
  126.            The message is sent once only.
  127.       GLSTHKM.MSG When a caller is NUMBER 1 in the top ten Message writters
  128.            GLSBULL will post this message to him/her
  129.            The message is sent once only.
  130.       GLSTHKC.MSG When a caller is NUMBER 1 in the top ten CALLERS
  131.            the GLSBULL will post this message to him/her
  132.            The message is sent once only.
  133.  
  134.        GLSOOPSF.MSG When a caller looses number 1 position this message
  135.            will be sent. (Top uploader)
  136.        GLSOOPSC.MSG When a caller looses number 1 position this message
  137.            will be sent. (Best caller)
  138.        GLSOOPSM.MSG When a caller looses number 1 position this message
  139.            will be sent. (Best message writer)
  140.  
  141.  
  142.       GLSBIRTH.MSG This message is sent to a caller on his/her birthday
  143.     GLSSUB.MSG Created when a person subscription is due
  144.     GLS1ST.MSG Sent to NEW callers
  145.  
  146.                    5
  147.  
  148.              WHAT DOES GLSBULL.EXE DO?
  149.              -------------------------
  150.   1 Writes bulletins for the top 14 callers, uploaders, message writers
  151.     and downloaders.
  152.  
  153.   2 Sends a welcome message to new callers
  154.  
  155.   3 Sends a birthday wish to your callers on their birthday
  156.  
  157.   4 Sends a subscription reminder notice to your VIPS's 7-21 days prior
  158.     to subscription expires. Will not send message after 40 days of using
  159.     GLSBULL while not registered.
  160.  
  161.   5 When a caller makes number one position on the Best callers/Uploaders
  162.     and message writers bulletins GLSBULL will send them a congratulations
  163.     message to encourage further uploading etc.
  164.     Will not send message after 40 days of using GLSBULL while not registered.
  165.  
  166.   6 When a person who held number one position looses it a Boo! Hisss
  167.     message is sent to him/her to encourage, again, more uploads/message
  168.     writing etc. Not really needed, just thrown in for fun.
  169.     Will not send message after 40 days of using GLSBULL while not registered.
  170.  
  171.   7 GLSBULL is year 2000 aware but is limited until RemoteAccess fully
  172.     supports 4 digit year entry and as soon as RA does the transition
  173.     an immediate update release of GLSBULL will be made available.
  174.  
  175.     For those not aware, any program which does not support 4 digit
  176.     year entry will fail to function correctly after the turn of the
  177.     century! meaning a person born in the year 1964 for example will
  178.     suddenly be 64 years old in the year 2000.
  179.  
  180.                     6
  181.  
  182.                 INSTALLATION
  183.                 ------------
  184.  
  185.   The GLSBULL archive comes with 5 files and after running the first time
  186.   several more files are created so it is strongly advised  give GLSBULL
  187.   a directory of its own.
  188.  
  189.   Once creating the directory and unpacking the files start GLSBULL.EXE
  190.   so that the required configuration file and other relevant files can be
  191.   created.
  192.  
  193.   GLSBULL will look for your RemoteAccess configuration files to obtain
  194.   information about you and your BBS so that you do not have to go through
  195.   a lengthy setup operation.
  196.  
  197.   Once obtaining your details GLSBULL will ask you if you want messages to
  198.   be sent to your callers. If you answer NO, GLSBULL will ask no more
  199.   questions and return to dos after writing your CFG file to HDD.
  200.  
  201.   If you answer YES, GLSBULL will ask you for a HUDSON message board number
  202.   which is required if you wish to have GLSBULL send messages to your callers.
  203.  
  204.   You are then given the option to have GLSBULL post your VIP's a reminder
  205.   to renew their subscription to your BBS 21 days before the due date.
  206.   GLSBULL will ask you to enter a security number between 0-65535.
  207.   Enter 65535 if you don't wish reminders sent by GLSBULL.
  208.  
  209.   If you have a registered copy of GLSBULL and enter a security number of
  210.   1000, GLSBULL will treat all users with a security of 1000 and above as
  211.   VIPS and send them a subscription reminder. In other words, GLBULL will
  212.   send a reminder to all those equal to or greater than the security number
  213.   you enter.
  214.  
  215.   Unregistered users will be restricted in that GLSBULL will only send a
  216.   reminder to those users EQUAL to the security number you enter.
  217.  
  218.   GLSBULL will now create several files with the file extension MSG which
  219.   are the templates used when posting messages to your callers. GLSBULL
  220.   will place your name and the name of your BBS in these messages. You
  221.   may edit these templates with a TXT editor if you wish.
  222.                     7
  223.                CONFIGURING RemoteAccess
  224.                ------------------------
  225.  
  226. GLSBULL generates 6 bulletin files these are:-
  227.  
  228.            GLSCALL.ASC  Top 14 callers
  229.            GLSMESS.ASC   "  "  message writers
  230.         GLSKUP.ASC   "  "  uploaders by K/bytes
  231.           GLSKDOWN.ASC   "  "  downloaders by K/bytes
  232.          GLSUP.ASC   "  "  uploders by files
  233.            GLSDOWN.ASC   "  "  downloaders by files
  234.  
  235. GLSBULL makes good use of RA's inbuilt colour codes so GLSBULL does not
  236. produce ANSI screens. Instead, ASC txt files are created and the colour
  237. codes are embedded into the bulletins. This way RA will send the ASC
  238. bulletins to all callers wether they be, ANSI, AVITAR, ASC or RIP in
  239. full colour or B/W if the caller is using a TTY terminal.
  240.  
  241. This not only saves on HDD space but also speeds the process of producing
  242. the bulletins PLUS you only have 6 bulletins in your text file directory
  243. instead of 12! In other words GLSBULL does not waste time/space duplicating
  244. the bulletins !
  245.  
  246. When you start GLSBULL she will look for your CONFIG.RA file which contains
  247. information about you and the location of your MSGBASE files and TXTFILES
  248. directory.
  249.                     8
  250. In the sample RACONFIG below you will see Textfiles  \ra\txtfiles so
  251. what-ever you have entered there, will be the location GLSBULL will create
  252. your bulletins. IMPORTANT if your running GLSBULL from a different DRIVE
  253. to you TXTFILES directory you MUST include the drive Letter in RACONFIG!
  254.  
  255.  
  256.      File   System  Options Modem   Manager
  257. ════════════════════╒═══════════╕═══════════════════════════════════════════════
  258. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  259. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ Site info │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  260. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ Addresses │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  261. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ Security  │▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  262. ▒▒╒═══════════════════════════════════════════════════════════════════ Paths ╕▒▒
  263. ▒▒│                                                                       │▒▒
  264. ▒▒│ System      \RA\                                                     │▒▒
  265. ▒▒│ Menus       \RA\MENUS\                                                 │▒▒
  266. ▒▒│ Textfiles   \RA\TXTFILES\   <<<<<< GLSBULL uses this directory to store  │▒▒
  267. ▒▒│ Msg base    \RA\MSGBASE\       your bulletins                       │▒▒
  268. ▒▒│ File base   \RA\FILES\                                                 │▒▒
  269. ▒▒│ File attach \RA\ATTACH\                                               │▒▒
  270. ▒▒│ Nodelist    \FD\NODELIST\                                           │▒▒
  271. ▒▒│ CD-ROM temp \RA\CDROM\                                                 │▒▒
  272. ▒▒│ Semaphore   \RA\SEM\                                                     │▒▒
  273. ▒▒│ Rearchive                                                           │▒▒
  274. ▒▒│ System log  \RA\RA.LOG                                                 │▒▒
  275. ▒▒│                                                                       │▒▒
  276. ▒▒╘══════════════════════════════════════════════════════════════════════════╛▒▒
  277. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  278. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  279. ────────────────────────────────────────────────────────────────────────────────
  280.  
  281.                     9
  282. After the bulletins are created you have to setup a menu in your BBS to
  283. display the bulletins to your callers. You may create a special menu for this
  284. purpose or use any of your current menu's.
  285.  
  286. Below you will see a sample menu which allows your callers to show the
  287. bulletins when they press the corresponding hot key. If they press A
  288. RA will display the bulletin "GLSCALL.ASC" etc etc.
  289.  
  290. ╒══════════════════════════════════════════════════════ C:\RA\MENUS\BULL.MNU   ╕
  291. │                         │***│ Display-H  │ bulletin                    │
  292. │                         │'A'│ Disp CR    │ GLSCALL                      │
  293. │                         │'B'│ Disp CR    │ GLSDOWN                      │
  294. │                         │'C'│ Disp CR    │ GLSUP                          │
  295. │                         │'D'│ Disp CR    │ GLSMESS                      │
  296. │                         │'E'│ Disp CR    │ GLSKDOWN                    │
  297. │                         │'F'│ Disp CR    │ GLSKUP                        │
  298. │                         │'M'│ Return     │                              │
  299. │                                                                             │
  300. │                                                                             │
  301. ╘══════════════════════════════════════════════════════════════════════════════╛
  302. Enter-Edit   Ins-Insert  Del-Delete  Esc-Exit
  303. ALT: L-Load  S-Save      P-Prompt    D-Display    N-Language
  304.  
  305.   Bellow is a more detailed layout on how to set RA up to display your
  306.   bulletins. Make sure you use a TYPE 45 menu command so that RA will
  307.   prompt the caller to press enter to continue at the end of the
  308.   bulletin.
  309. ╒══════════════════════════════════════════════════════════════ Edit Menu Item ╕
  310. │                                                                             │
  311. │         1      2       3       4       5       6       7       │
  312. │ 123456789012345678901234567890123456789012345678901234567890123456789012345  │
  313. │ ;                                                                         │
  314. │                                                                             │
  315. │ GLSCALL                                                                     │
  316. │                                                                             │
  317. │ Action   Display .ANS/.ASC with CR pause at end (Type 45)                 │
  318. │ Display                                                                     │
  319. │ OptData                                                                     │
  320. │ HotKey   A                                                               │
  321. │ AutoExec No                                                             │
  322. │ Colour   Colour example                                                     │
  323. │                                                                             │
  324. │ MinSec   0              TimeUsed 0              FlatCost 0       │
  325. │ MaxSec   0              TimeLeft 0              TimeCost 0       │
  326. │ A flags  --------        Age      0             Terminal Any   │
  327. │ B flags  --------        MinSpeed 0             Nodes         │
  328. │ C flags  --------        MaxSpeed 0             Groups               │
  329. │ D flags  --------        Credit   0             DayTimes           │
  330. │                                                                             │
  331. │                                                                             │
  332. ╘══════════════════════════════════════════════════════════════════════════════╛
  333. What will happen when item is selected
  334.  
  335.                     10
  336.  
  337.                 DAILY MAINTENANCE
  338.                 -----------------
  339.  
  340.   GLSBULL should be included in your daily maintenance so that bulletins
  341.   can be updated daily. DO NOT RUN GLSBULL more than once a day if you have
  342.   the message posting active otherwise GLSBULL may post duplicate
  343.   messages to your callers. You have been warned!
  344.  
  345.   From this point on it is assumed you have read the docs that came with
  346.   your copy of RemoteAccess and you understand the terms used.
  347.  
  348.   A typical batch file that runs GLSBULL might look something like this
  349.  
  350.   When useing RA without a mailer you will have to setup an EVENT ERRORLEVEL
  351.   EXIT in RACONFIG. In this sample we will have RA exit with an errorlevel
  352.   of 100 to activate GLSBULL daily.
  353.  
  354. :STARTBBS
  355. CD\RA\NODE1
  356. RA -N1 -B%1%5 -D
  357. IF ERRORLEVEL 100 GOTO DAILYMAINT:
  358. GOTO STARTBBS
  359. :DAILYMAINT
  360. CD\RA\DOOR\GLSBULL
  361. GLSBULL.EXE
  362. GOTO STARTBBS:
  363.                     11
  364.   When using RA with a front end mailer such as Frontdoor you will have
  365.   to set your mailer up to do a forced event X exit which will ensure
  366.   that GLSBULL is run daily which must be done if you have activated
  367.   the message posting feature.
  368.  
  369.   A typical batch file used in conjunction with RA and Frontdoor might
  370.   look something like this.
  371.  
  372. @ECHO OFF
  373. :START
  374. CD\FD
  375. FD
  376. IF ERRORLEVEL 220 GOTO MAILRECIEVED
  377. IF ERRORLEVEL 210 GOTO DAILYMAINT
  378. IF ERRORLEVEL 100 GOTO BBS
  379. GOTO START
  380.  
  381. :BBS
  382. DOBBS.BAT
  383. GOTO START
  384.  
  385. :MAILRECIEVED
  386. CD\MAIL
  387. FMAIL3 TOSS
  388. FMAIL3 IMPORT
  389. GOTO START
  390.  
  391. ===========================================================================
  392. REM -------- DAILY Maintenance
  393. :DAILYMAINT
  394. CD \RA\DOOR\GLSBULL
  395. GLSBULL.EXE         (((GLSBULL requires no COMMAND LINES)))
  396. ===========================================================================
  397.  
  398. CD \MAIL
  399. FMAIL3 PACK
  400. FTOOLS3 MAINT /D /N /P
  401. GOTO START
  402.  
  403.                    12
  404.  
  405.               EXCLUDING USERS FROM BULLETINS
  406.               ------------------------------
  407.  
  408.   GLSBULL allows you to exclude up-to 10 users from the bulletins. This
  409.   is done by editing the control file called GLSBULL.SKP"
  410.  
  411.   It is not necessary to place your name in the list as GLSBULL excludes
  412.   the sysop by default.
  413.  
  414.   The names of the users MUST appear exactly how they do in RA's users base.
  415.   in other words the names are CASE-SENSATIVE!!!!!
  416.  
  417.   NOTE: GLSBULL will only exclude the 10 users you define within your 40
  418.   day evaluation period. After 40 days, GLSBULL will not READ in the names
  419.   your define until you register your copy.
  420.  
  421.   Enjoy!
  422.  
  423.